Create Retail User

👤➡️🌐 Create Retail User Request (Client → WCF REST Service)

This message is sent by the Client to the WCF REST Service for creating a Web Retail User in ODIN and WebAdmin. The Service will validate the request based on the parameters sent and upon successful creation of user will send the response back in xml format. In case of failure it will send a failure response.

📘 Field Details

Tag	Field Name	Req’d	Data Type (Max)	Comment
63	Message Version	Y	String (10)	Fixed Value – `FT1.0`
64	Message Type	Y	Integer	Fixed Value – `301`
67	Reserved PG Dealer Id	Y	String (10)	Reserved PG Dealer Id
4	Session Id	Y	String (100)	Must be same as Session Id received in Logon Response
201	User Id	Y	String (10)	New Web Retail User Id
202	Group Id	Y	String (10)	Group Id of the user
203	Manager Id	Y	String (50)	Determines ODIN Manager for user creation. Must match Manager IP/DNS in WebAdmin under Configuration → Odin Manager Settings → Manager IP. Note: Optional for non-Odin users
204	Family Id	O	String (10)	Family Id of the user
205	Parent Id	O	String (10)	Parent Id of the user
206	Name	Y	String (40)	First & Last Name separated by space
207	Password	O	String (24)	Encrypted using AES. Decrypted password: 6–12 characters, alphanumeric, allowed special characters: `< > . : ; ~ ! @ # $ % ^ * ( ) + - { } \ / [ ]`
208	User Category	Y	Short	Category Id: `2` – Retail User `4` – Web Retail User `3` – Institutional User `5` – Institutional Web User Note: Mandatory even for non-Odin users
209	Address Line 1	O	String (40)	Address Line 1
210	Address Line 2	O	String (40)	Address Line 2
211	City	O	String (40)	City
212	Pin code	O	String (6)	Pin code
213	Telephone No	O	String (20)	Telephone No
214	Mobile No	O	String (14)	Mobile No
215	Fax No	O	String (20)	Fax No
216	Email Id	O	String (39)	Email Id
217	Pan Card	O	String (10)	Pan Card
218	User Status	Y	Char (1)	`A` – Active, `S` – Suspended, `I` – Inactive
219	Surveillance Auto or Manual	O	Short	`0` – Auto, `1` – Manual
220	Trading Allowed	Y	String (100)	Comma-separated Segment IDs. Optional for non-Odin users
221	Market Data Allowed	Y	String (100)	Comma-separated Segment IDs. Optional for non-Odin users
222	Login Allowed	Y	String (100)	Comma-separated Segment IDs. Optional for non-Odin users
223	Login Type	Y	String	Comma-separated Product IDs: `DIET` – 1 `ODIN AERO` – 13 `API_WEB (IBT-EX)` – 16 `API_MOBILE (MOBILE EX)` – 17 `BREEZE` – 20 `ODIN_WAVE_MOB (Wave Mobile)` – 23 Optional for non-Odin users
224	Bank Details Data	O	String (800)	Multiple bank accounts separated by `$`. Format: `BankId,BranchName,BranchCity,AccountNo,CustomerId,AccountType,IsDefaultBank,PGProduct,IFSCCode,$...`
225	DP Details	O	String (800)	Multiple Demat accounts separated by `$`. Format: `DP Id,Client Beneficiary Id,Holding Type,Default DP,Guardian First Name,Guardian Last Name,Guardian DOB,Guardian PAN,Second Holder First Name,Second Holder Last Name,Second Holder DOB,Second Holder PAN,Third Holder First Name,Third Holder Last Name,Third Holder DOB,Third Holder PAN,Remarks`
226	Group Admin Id	O	String (10)	Group Admin Id
227	Unique Reference Number	O	String (20)	Unique reference number generated by Third Party Application
228	General Settings Template Name	Y	String (50)	Pass GST template if modifying user’s default GST template
229	First Holder DOB	O	String (10)	DOB in `DD-MM-YYYY` format. Mandatory for DP details (Tag-225) & MF UCC (Tag-232). Also used for Incorporation Date if Tag-238 = 1
230	Odin User Type	O	Short (1)	`0` – Non ODIN User `1` – ODIN User Default = 1
231	Product Allowed	O	String (50)	Comma-separated Product IDs: `2` – Mutual Fund `3` – IPO `4` – PMS `14` – BOND `32` – 3 in 1 Account
232	MF UCC Details	O	String (1000)	Exchange-wise UCC details mapping, comma-separated: `BSEUCC,NSEUCC1,NSEUCC2,NSEUCC3,ModeAllowed,BSETransactionMode,BSE UCC Mode,Holding Mode,MF 2ndApp First Name,...` Mandatory if Product allowed for MF
233	Gender	M	String (2)	`M` – Male `F` – Female `NA` – Firm Account
234	Client Type	O	String (10)	Mandatory if Product allowed for IPO, BONDS, PMS
235	Tax Status	O	String (10)	Mandatory if Product allowed for MF, BONDS, PMS
236	Occupation	O	String (10)	Mandatory if Product allowed for MF, BONDS, PMS
237	Form60	O	Short (1)	`Y` – Yes `N` – No
238	Incorporation Date Flag	O	Short (1)	Pass `1` if Incorporation date needs update for Firm. Fill date in Tag-229
239	Father/Husband Name	O	String (50)	Father/Husband Name
240	Global Flag	O	Short	`0` – Global not considered `1` – Global considered Default = 0
241	Number of Orders Per Second	O	Long	Default = -1 Max = 999
242	Max broadcast scrip allowed	O	Long	Default = -1 Max = 99999999
243	Branch Name	O	String (15)	Branch Name
244	POA	O	Short	`0` – POA `2` – Non-POA Default = 0
247	Max GTD Allowed	O	Long	If value = `-1`, GTD checkbox unchecked Max = 9999
248	Product Type	O	Short	`1` – Margin/IntraDay `2` – Delivery/CarryForward `4` – MarginPlus `8` – MTF `64` – PTST
999	Check Sum Value	Y	Integer	Checksum based on entire string. Must be last tag in request

Example String for generating check sum

63=FT1.0|64=301|67=RESERVEDPG|4=0x01C6694EA406031D48B2AA88FB8CCA|201=WEBRET1|202=HO|203=10.0.10.0|204=|205=|206=|207=addExxvEtd4sTPOJ078asd|208=4|209=Address Line 1|210=Address Line 2|211=Mumbai|212=400001|213=|214=9874563210|215=|216=aaa@bbb.com|217=AAAAA1234A|218=A|219=1|220=1,2,3,4,5|221=1,2,3,4,5|222=1,2,3,4,5|223=1,8,9|224=UTI,Kandivali,Mumbai,02145214521423,1111222,CA,0,NSE EQUITIES$HDFC,Andheri,Mumbai,04874562102145,99998888,CA,0,NSE EQUITIES|225=IN300940,12345678,Single,0,,,,,,,,,,,,,NA|226=|227=11071700121312014520|228=USERMIG|229=21-01-1995|230=1|231=2,3,4,14|232=BSEUCC,NSEUCC1,NSEUCC2,,7,2,,JO,Hardik,Kothiya,QWERT1212A,1,T1,T1,HHHHH1234H,1,G1,G2,HHHHH1111A,31-08-1991,1,MUMBAI,N1,N2,31-08-1993,Self,Surat,AM,,AM|233=M|234=IND|235=1|236=1|237=N|238=|239=HardikKumar|240=1|241=3|242=15|243=MUMBAI|244=0|247=10|248=1

Example String for creating retail user

Below is the String to be passed for creating retail user along with checksum value

CreateRetailUser
("63=FT1.0|64=301|67=RESERVEDPG|4=0x01C6694EA406031D48B2AA88FB8CCA|201=WEBRET1|202=HO|203=10.0.10.0|204=|205=|206=|207=addExxvEtd4sTPOJ078asd|208=4|209=Address Line 1|210=Address Line 2|211=Mumbai|212=400001|213=|214=9874563210|215=|216=aaa@bbb.com|217=AAAAA1234A|218=A|219=1|220=1,2,3,4,5|221=1,2,3,4,5|222=1,2,3,4,5|223=1,8,9|224=UTI,Kandivali,Mumbai,02145214521423,1111222,CA,0,NSE EQUITIES$HDFC,Andheri,Mumbai,04874562102145,99998888,CA,0,NSE EQUITIES|225=IN300940,12345678,Single,0,,,,,,,,,,,,,NA|226=|227=11071700121312014520|228=USERMIG|229=21-01-1995|230=1|231=2,3,4,14|232=BSEUCC,NSEUCC1,NSEUCC2,,7,2,,JO,Hardik,Kothiya,QWERT1212A,1,T1,T1,HHHHH1234H,1,G1,G2,HHHHH1111A,31-08-1991,1,MUMBAI,N1,N2,31-08-1993,Self,Surat,AM,,AM|233=M|234=IND|235=1|236=1|237=N|238=|239=HardikKumar|240=1|241=3|242=15|243=MUMBAI|244=0|247=10|248=1|999=145")

Notes

Note 1

Post successful user creation in ODIN, the web service shall assign the following default templates automatically so that clients can start trading seamlessly.
Such default templates shall be assigned if they are available in the ODIN Database.
Members should make provision in their ODIN Admin for at least one standard default template for all such templates that need to be assigned to new users to onboard and trade seamlessly.

System shall mark newly created users with Margin/Prime as ON by default, same as existing functionality in ODIN User Maintenance window.

List of Templates:

Default Surveillance Template
Default CRP Template
Default User-Privileges Template
Default Client Facility Template
Default Authentication Template
Default Quantity and Value Limit Template
Default News Category Template
Default Brokerage Template
Default Auto Square Off %

Note 2

Same method can be used to convert Non-Odin user to ODIN User.

Note 3

All API users should refrain from using the special characters unless explicitly mentioned in a TAG:

|
$
=
, (Comma)
> (Greater than)
< (Less than)

🏦📄 Bank Details Data

Field Name	Req’d	Data Type (Max)	Comment
Bank Id	M	String (20)	Bank Id of the user
Bank Branch Name	O	String (40)	Bank Branch Name of the respective Bank Id
Bank Branch City	O	String (35)	Bank Branch City of the respective Bank Id
Bank Account No	M	String (20)	Bank Account Number of the respective Bank Id
Bank Customer Id	O	String (10)	Bank Customer Id of the respective Bank Id
Bank Account Type	M	String (3)	Bank Account Type. Allowed values: `CA`, `SB`, `NRE`, `NRO`
Is Default Bank	O	Integer	`1` if Default Bank, else `0`
PG Product	O	String (100)	Name of the PG Product to be mapped to the Bank
IFSC Code	O	String (11)	Bank IFSC code

📊📄 DP Details Data

Field Name	Req’d	Data Type (Max)	Comment
DP Id	M	String (8)	DP Id
Client Beneficiary Id	M	String (16)	Client Beneficiary Id
Holding Type	M	String (35)	Holding Type: `1` – 1st Holder `2` – Joint Holder 1+1 `3` – Joint Holder 1+2
Default DP	O	Char (1)	`Y` = Yes, `N` = No
Guardian First Name	O	String (25)	Applicable if First Holder is Minor
Guardian Last Name	O	String (25)	Applicable if First Holder is Minor
Guardian DOB	O	String (10)	DOB in `DD-MM-YYYY` format (Applicable if First Holder is Minor)
Guardian PAN	O	String (10)	Applicable if First Holder is Minor
Second Holder First Name	O	String (25)	Second Holder First Name
Second Holder Last Name	O	String (25)	Second Holder Last Name
Second Holder DOB	O	String (10)	DOB in `DD-MM-YYYY` format
Second Holder PAN	O	String (10)	Second Holder PAN
Third Holder First Name	O	String (25)	Third Holder First Name
Third Holder Last Name	O	String (25)	Third Holder Last Name
Third Holder DOB	O	String (10)	DOB in `DD-MM-YYYY` format
Third Holder PAN	O	String (10)	Third Holder PAN
Remarks	O	String (25)	Remarks

📈🗂️ List of Exchanges and Market Segment IDs

The following is the list of Exchanges and their respective Market Segment IDs supported by the API:

Exchange	Market Segment ID
NSE Cash	1
NSE Derivatives	2
BSE Cash	3
BSE Derivatives	4
MCX Futures	5
NCDEX Futures	7
BSE SLBM	9
MSE Curr Futures	11
NSECDS Futures	13
MSE Cash	15
MSE Derivatives	16
NSE SLBM	17
BSE Commodity	18
NSE Commodity F&O	19
NSE-OFS	33
BSE-OFS	25
ICEX	34
BSE CDS	38
Mutual Fund	41

🧾📊 MF UCC Details Data

Field Name	Req’d	Data Type (Max)	Comment
BSE UCC	O	String (10)	Enter BSE UCC (First Holder). Optional if NSE UCC1 is specified
NSE UCC1	O	String (10)	Enter NSE UCC (First Holder). Optional if BSE UCC is specified
NSE UCC2	O	String (10)	Enter NSE UCC2 (Second Holder)
NSE UCC3	O	String (10)	Enter NSE UCC3 (Third Holder)
Mode Allowed	M	Short	Allowed values: `1` – RTA `2` – NSE `4` – BSE `3` – RTA+NSE `5` – RTA+BSE `6` – NSE+BSE `7` – RTA+NSE+BSE
BSE Transaction Mode	O	String (1)	Applicable if Mode Allowed for BSE: `0` – Demat `1` – Physical `2` – Both
BSE UCC Mode	O	Short (1)	Reserved field (Pass blank for now): `0` – MFI `1` – MFD
Holding Mode	M	String (5)	MF Holding Mode: `SI` – Single `JO` – Joint `AS` – Anyone or Survivor
MF 2ndApp First Name	O	String (25)	Mandatory if Holding Mode is JO or AS
MF 2nd App Last Name	O	String (25)	Mandatory if Holding Mode is JO or AS
MF2ndAppPANNo	O	String (10)	Mandatory if Holding Mode is JO or AS
MF 2nd Appl Form 60 Status	O	Short (1)	`1` = Form60 Submitted
MF3rdAppFirstName	O	String (25)	Third Holder First Name
MF3rdAppLastName	O	String (25)	Third Holder Last Name
MF3rdAppPANNo	O	String (10)	Third Holder PAN
MF3rdApplForm60Status	O	Short (1)	`1` = Form60 Submitted
MF Guardian First Name	O	String (25)	Mandatory if First Holder is minor & MF Allowed
MF Guardian Last Name	O	String (25)	Mandatory if First Holder is minor & MF Allowed
MF Guardian PANNo	O	String (10)	Mandatory if Client is minor & MF Allowed
MF Guardian DOB	O	String (10)	Guardian DOB (DD-MM-YYYY). Must be ≥18 years
MF Guardian Form60 Status	O	Short (1)	`1` = Form60 Submitted
MF Guardian Address	O	String (300)	Mandatory if Client is minor & MF Allowed
MF Nominee First Name	O	String (25)	Nominee First Name
MF Nominee Last Name	O	String (25)	Nominee Last Name
MF Nominee DOB	O	String (10)	Nominee DOB
MF Nominee Relation	O	String (20)	Nominee Relation
MF Nominee Address	O	String (300)	Nominee Address
MF Karvy Payment Mode	O	String (2)	Mandatory if MF allowed: `AM` – AutoMapping `C` – Cheque `E` – ECS `R` – RTGS `N` – NEFT
MF Karvy Payment Code	O	String (11)	Mandatory if MF allowed and Payment Mode is E, R, or N
MF Other RTA Payment Mode	O	String (10)	Mandatory if MF allowed: `AM` – AutoMapping `CHEQUE` – Cheque